diff --git a/assets/src/bundles/vault/vault-create-tasks.js b/assets/src/bundles/vault/vault-create-tasks.js --- a/assets/src/bundles/vault/vault-create-tasks.js +++ b/assets/src/bundles/vault/vault-create-tasks.js @@ -7,7 +7,7 @@ import * as EmailValidator from 'email-validator'; -import {handleFetchError, csrfPost, htmlAlert} from 'utils/functions'; +import {csrfPost, handleFetchError, htmlAlert} from 'utils/functions'; const alertStyle = { 'position': 'fixed', @@ -99,7 +99,7 @@ const cookingTaskCreatedAlert = $(htmlAlert('success', 'Archive cooking request successfully submitted.
' + - `Go to the Downloads page ` + + `Go to the Downloads page ` + 'to get the download link once it is ready.', true)); cookingTaskCreatedAlert.css(alertStyle); diff --git a/cypress/e2e/vault.cy.js b/cypress/e2e/vault.cy.js --- a/cypress/e2e/vault.cy.js +++ b/cypress/e2e/vault.cy.js @@ -174,7 +174,7 @@ updateVaultItemList(this.vaultItems); - cy.visit(this.Urls.browse_vault()); + cy.visit(this.Urls.vault()); cy.contains(`#vault-task-${CSS.escape(this.revision)} button`, 'Download') .click(); @@ -183,7 +183,7 @@ it('should display and upgrade previous cooking tasks from the legacy format', function() { updateVaultItemList(this.legacyVaultItems); - cy.visit(this.Urls.browse_vault()); + cy.visit(this.Urls.vault()); // Check it is displayed cy.contains(`#vault-task-${CSS.escape(this.revision)} button`, 'Download') @@ -246,7 +246,7 @@ .should('contain', 'Archive cooking request successfully submitted.'); // Go to Downloads page - cy.visit(this.Urls.browse_vault()); + cy.visit(this.Urls.vault()); cy.wait('@checkVaultCookingTask').then(() => { testStatus(this.directory, progressbarColors['new'], 'new', 'new'); @@ -334,7 +334,7 @@ .should('contain', 'Archive cooking request successfully submitted.'); // Go to Downloads page - cy.visit(this.Urls.browse_vault()); + cy.visit(this.Urls.vault()); cy.wait('@checkVaultCookingTask').then(() => { testStatus(this.revision, progressbarColors['new'], 'new', 'new'); @@ -454,7 +454,7 @@ } }).as('fetchCookedArchive'); - cy.visit(this.Urls.browse_vault()) + cy.visit(this.Urls.vault()) .get(`#vault-task-${CSS.escape(this.revision)} .vault-dl-link button`) .click(); @@ -483,7 +483,7 @@ updateVaultItemList(this.vaultItems); - cy.visit(this.Urls.browse_vault()) + cy.visit(this.Urls.vault()) .get(`#vault-task-${CSS.escape(this.revision)}`) .find('input[type="checkbox"]') .click({force: true}); diff --git a/docs/uri-scheme-api-vault.rst b/docs/uri-scheme-api-vault.rst --- a/docs/uri-scheme-api-vault.rst +++ b/docs/uri-scheme-api-vault.rst @@ -1,10 +1,10 @@ Vault ----- -.. autosimple:: swh.web.api.views.vault.api_vault_cook_directory +.. autosimple:: swh.web.vault.api_views.api_vault_cook_directory -.. autosimple:: swh.web.api.views.vault.api_vault_fetch_directory +.. autosimple:: swh.web.vault.api_views.api_vault_fetch_directory -.. autosimple:: swh.web.api.views.vault.api_vault_cook_revision_gitfast +.. autosimple:: swh.web.vault.api_views.api_vault_cook_revision_gitfast -.. autosimple:: swh.web.api.views.vault.api_vault_fetch_revision_gitfast +.. autosimple:: swh.web.vault.api_views.api_vault_fetch_revision_gitfast diff --git a/swh/web/api/urls.py b/swh/web/api/urls.py --- a/swh/web/api/urls.py +++ b/swh/web/api/urls.py @@ -17,6 +17,5 @@ import swh.web.api.views.revision # noqa import swh.web.api.views.snapshot # noqa import swh.web.api.views.stat # noqa -import swh.web.api.views.vault # noqa urlpatterns = APIUrls.get_url_patterns() diff --git a/swh/web/browse/templates/includes/top-navigation.html b/swh/web/browse/templates/includes/top-navigation.html --- a/swh/web/browse/templates/includes/top-navigation.html +++ b/swh/web/browse/templates/includes/top-navigation.html @@ -125,8 +125,10 @@ {% endif %} {% if show_actions %} - {% if not snapshot_context or not snapshot_context.is_empty %} - {% include "./vault-create-tasks.html" %} + {% if "swh.web.vault" in SWH_DJANGO_APPS %} + {% if not snapshot_context or not snapshot_context.is_empty %} + {% include "includes/vault-create-tasks.html" %} + {% endif %} {% endif %} {% if "swh.web.save_code_now" in SWH_DJANGO_APPS %} {% include "./take-new-snapshot.html" %} diff --git a/swh/web/browse/urls.py b/swh/web/browse/urls.py --- a/swh/web/browse/urls.py +++ b/swh/web/browse/urls.py @@ -36,14 +36,6 @@ ) -def _browse_vault_view(request: HttpRequest) -> HttpResponse: - return render( - request, - "browse-vault-ui.html", - {"heading": "Download archive content from the Vault"}, - ) - - def _browse_origin_save_view(request: HttpRequest) -> HttpResponse: return redirect(reverse("origin-save")) @@ -56,7 +48,6 @@ url(r"^browse/$", _browse_search_view), url(r"^browse/help/$", _browse_help_view, name="browse-help"), url(r"^browse/search/$", _browse_search_view, name="browse-search"), - url(r"^browse/vault/$", _browse_vault_view, name="browse-vault"), # for backward compatibility url(r"^browse/origin/save/$", _browse_origin_save_view, name="browse-origin-save"), url( diff --git a/swh/web/config.py b/swh/web/config.py --- a/swh/web/config.py +++ b/swh/web/config.py @@ -168,6 +168,7 @@ "swh.web.metrics", "swh.web.banners", "swh.web.jslicenses", + "swh.web.vault", ], ), } diff --git a/swh/web/templates/layout.html b/swh/web/templates/layout.html --- a/swh/web/templates/layout.html +++ b/swh/web/templates/layout.html @@ -199,12 +199,14 @@

Search

-
  • - - -

    Downloads

    -     -
    • + {% if "swh.web.vault" in SWH_DJANGO_APPS %} +
  • + + +

    Downloads

    +     +
    • + {% endif %} {% if "swh.web.save_code_now" in SWH_DJANGO_APPS %}
  • diff --git a/swh/web/tests/vault/__init__.py b/swh/web/tests/vault/__init__.py new file mode 100644 diff --git a/swh/web/tests/api/views/test_vault.py b/swh/web/tests/vault/test_apiviews.py rename from swh/web/tests/api/views/test_vault.py rename to swh/web/tests/vault/test_apiviews.py --- a/swh/web/tests/api/views/test_vault.py +++ b/swh/web/tests/vault/test_apiviews.py @@ -22,7 +22,7 @@ def test_api_vault_cook(api_client, mocker, directory, revision): - mock_archive = mocker.patch("swh.web.api.views.vault.archive") + mock_archive = mocker.patch("swh.web.vault.api_views.archive") for bundle_type, swhid, content_type, in ( ("flat", f"swh:1:dir:{directory}", "application/gzip"), @@ -183,7 +183,7 @@ def test_api_vault_cook_legacy(api_client, mocker, directory, revision): - mock_archive = mocker.patch("swh.web.api.views.vault.archive") + mock_archive = mocker.patch("swh.web.vault.api_views.archive") for obj_type, bundle_type, response_obj_type, obj_id in ( ("directory", "flat", "directory", directory), diff --git a/swh/web/tests/vault/test_app.py b/swh/web/tests/vault/test_app.py new file mode 100644 --- /dev/null +++ b/swh/web/tests/vault/test_app.py @@ -0,0 +1,37 @@ +# Copyright (C) 2022 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU Affero General Public License version 3, or any later version +# See top-level LICENSE file for more information + +import pytest + +from django.urls import get_resolver + +from swh.web.tests.django_asserts import assert_contains, assert_not_contains +from swh.web.tests.helpers import check_html_get_response +from swh.web.utils import reverse +from swh.web.vault.urls import urlpatterns + + +@pytest.mark.django_db +def test_banners_deactivate(client, django_settings, directory): + """Check vault feature is deactivated when the swh.web.vault django + application is not in installed apps.""" + + url = reverse("browse-directory", url_args={"sha1_git": directory}) + + resp = check_html_get_response(client, url, status_code=200) + assert_contains(resp, "swh-vault-item") + assert_contains(resp, "swh-vault-download") + + django_settings.SWH_DJANGO_APPS = [ + app for app in django_settings.SWH_DJANGO_APPS if app != "swh.web.vault" + ] + + resp = check_html_get_response(client, url, status_code=200) + assert_not_contains(resp, "swh-vault-item") + assert_not_contains(resp, "swh-vault-download") + + vault_view_names = set(urlpattern.name for urlpattern in urlpatterns) + all_view_names = set(get_resolver().reverse_dict.keys()) + assert vault_view_names & all_view_names == set() diff --git a/swh/web/tests/vault/test_views.py b/swh/web/tests/vault/test_views.py new file mode 100644 --- /dev/null +++ b/swh/web/tests/vault/test_views.py @@ -0,0 +1,18 @@ +# Copyright (C) 2022 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU Affero General Public License version 3, or any later version +# See top-level LICENSE file for more information + +from swh.web.tests.helpers import check_html_get_response +from swh.web.utils import reverse + + +def test_vault_view(client): + url = reverse("vault") + check_html_get_response(client, url, status_code=200, template_used="vault-ui.html") + + +def test_browse_vault_view(client): + url = reverse("browse-vault") + resp = check_html_get_response(client, url, status_code=302) + assert resp["location"] == reverse("vault") diff --git a/swh/web/vault/__init__.py b/swh/web/vault/__init__.py new file mode 100644 diff --git a/swh/web/api/views/vault.py b/swh/web/vault/api_views.py rename from swh/web/api/views/vault.py rename to swh/web/vault/api_views.py diff --git a/swh/web/browse/templates/includes/vault-common.html b/swh/web/vault/templates/includes/vault-common.html rename from swh/web/browse/templates/includes/vault-common.html rename to swh/web/vault/templates/includes/vault-common.html diff --git a/swh/web/browse/templates/includes/vault-create-tasks.html b/swh/web/vault/templates/includes/vault-create-tasks.html rename from swh/web/browse/templates/includes/vault-create-tasks.html rename to swh/web/vault/templates/includes/vault-create-tasks.html diff --git a/swh/web/browse/templates/browse-vault-ui.html b/swh/web/vault/templates/vault-ui.html rename from swh/web/browse/templates/browse-vault-ui.html rename to swh/web/vault/templates/vault-ui.html --- a/swh/web/browse/templates/browse-vault-ui.html +++ b/swh/web/vault/templates/vault-ui.html @@ -1,4 +1,4 @@ -{% extends "./browse.html" %} +{% extends "browse.html" %} {% comment %} Copyright (C) 2017-2022 The Software Heritage developers diff --git a/swh/web/vault/urls.py b/swh/web/vault/urls.py new file mode 100644 --- /dev/null +++ b/swh/web/vault/urls.py @@ -0,0 +1,30 @@ +# Copyright (C) 2017-2022 The Software Heritage developers +# See the AUTHORS file at the top-level directory of this distribution +# License: GNU Affero General Public License version 3, or any later version +# See top-level LICENSE file for more information + +from django.http import HttpRequest, HttpResponse +from django.shortcuts import redirect, render +from django.urls import re_path as url + +# register Web API endpoints +import swh.web.vault.api_views # noqa + + +def vault_view(request: HttpRequest) -> HttpResponse: + return render( + request, + "vault-ui.html", + {"heading": "Download archive content from the Vault"}, + ) + + +def browse_vault_view(request: HttpRequest) -> HttpResponse: + return redirect("vault") + + +urlpatterns = [ + url(r"^vault/$", vault_view, name="vault"), + # for backward compatibility + url(r"^browse/vault/$", browse_vault_view, name="browse-vault"), +]